package com.terrapages.wmsc4j.client.mosaic;

import java.awt.Image;
import java.awt.image.BufferedImage;

import com.terrapages.wmsc4j.bean.BBox;

/**
 * <p>Represents an {@link Image} of a geospatial map. Has the actual image inside as well as the
 * geospatial boundingbox coordinates it represents.</p>
 * 
 * <p>Returned by the MosaicWMSCClient.getMap() function, which is all it's really used for.
 * It contains the image ({@link BufferedImage}) you wanted but also the updated boundingbox. 
 * Although the best attempt is made, you are extreamly unlikely to get the exact bounding-box asked for, 
 * it was thus decided you might want to know what the actual bounding-box, represented as the image, is.</p>
 * 
 * @author mvivian
 * @date 23 May 2007
 */
public class MosaicWMSCResponse {
	private BufferedImage image;
	private BBox boundingBox;
	
	/**
	 * Creates a MapImage object
	 * 
	 * @param image
	 * @param boundingBox
	 */
	public MosaicWMSCResponse(final BufferedImage image, final BBox boundingBox) {
		this.image = image;
		this.boundingBox = boundingBox;
	}
	
	/**
	 * @return the boundingBox
	 */
	public final BBox getBoundingBox() {
		return boundingBox;
	}
	
	/**
	 * @param boundingBox the boundingBox to set
	 */
	public final void setBoundingBox(final BBox boundingBox) {
		this.boundingBox = boundingBox;
	}
	
	/**
	 * @return the image
	 */
	public final BufferedImage getImage() {
		return image;
	}
	
	/**
	 * @param image the image to set
	 */
	public final void setImage(final BufferedImage image) {
		this.image = image;
	}
	
	
}
